Number Check

The Validate Phone process typically involves confirming the accuracy and legitimacy of a phone number provided by a user.

1 Go to Workspace > Workflows, and click on the flow created for Validate Phone. If you need understanding in creating a workflow, refer to the step-by-step guide here.

2 Hover over the plus (+) symbol and select Workflow. From the list, click Validate Phone to add it.

3 Click on the newly added workflow, then select the General tab to customize your preferences.

Manage General

(*) Indicates an action to be mandatory.

Name	Description
Display Name*	Set a name to the workflow for easy identification.
Description	Summarize the purpose and functionality of this workflow module.
Enable	This toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed.
Skip	Allows the user to skip this specific workflow module during execution. When selected, it provides an option to bypass the particular workflow without affecting other modules in the sequence.
Rule	This determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here.

4 Then, click on the Configs tab to set the necessary configurations. When configuring the Verification Type, by default NUMBER_VALIDATION is set, but there are two types available: NUMBER_VALIDATION and MISSED_CALL.

5 Choose NUMBER_VALIDATION for Verification Type.

Manage Configs

Name

Description

Phone Number Validation Claims

Claims specify the information that should appear in the generated response. Note that only the selected claims will appear in the final response. The claims for Validate Phone Number are, phone_no_valid_verified: This denotes whether the phone number validation is completed ("True" if completed, "False" if not). international_format: The phone number formatted in international format, suitable for global communication. country_prefix: The prefix used for dialing out of the country where the phone number is registered. phone_no_valid_verified_at: Timestamp (in Unix epoch format) indicating when the phone number validation was done. valid: Indicates of whether the phone number is valid ("True" if completed, "False" if not). number: The actual phone number in its original format. country_code: The country code associated with the phone number, indicating its country of origin. valid_phone_no: Indicates whether the phone number is valid ("True" if completed, "False" if not). carrier: The telecom carrier or provider associated with the phone number. local_format: The phone number formatted in a local format, typically used within its country of origin. line_type: Specifies the type of line associated with the phone number (e.g., mobile, landline, VoIP). country_name: The name of the country associated with the phone number. location: The geographical location or area associated with the phone number.

6 After you've configured everything needed, click on the SAVE button.

7 Proceed to attach the workflow to the relevant application for execution. Refer to instructions on how to attach a workflow to an application here.

How it Works

1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.

2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.

3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.

4 Begin by providing the Phone Number and click on Submit.

5 The verification process will be completed only if the entered data is valid.

If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.

6 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.

7 Here is a sample response for Validate Phone:

{
    "workflow": "verification",
    "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    "user_id": "mark@gmail.com",
    "phone_no_valid_verified": "true/false",
    "international_format": "+9183xxxxxxxxx",
    "country_prefix": "+91",
    "phone_no_valid_verified_at": "1719569072",
    "valid": "xxxx",
    "number": "9183xxxxxxxx",
    "country_code": "IN",
    "valid_phone_no": "9183xxxxxxxx",
    "carrier": "Aircel Cellular Ltd",
    "local_format": "083xxxxxxxx",
    "line_type": "mobile",
    "country_name": "India (Republic of)",
    "location": "Mumbai",
}